// =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= //
//  »Project«   Talina Gaming System (TgS) (∂)
//  »File«      TgS Common - Math API [Matrix] [F] [F].i_inc
//  »Author«    Andrew Aye (EMail: mailto:andrew.aye@gmail.com, Web: http://www.andrewaye.com)
//  »Version«   4.0
// ------------------------------------------------------------------------------------------------------------------------------ //
//  Copyright: © 2002-2010, Andrew Aye.  All Rights Reserved.
//  This software is free for non-commercial use. Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met: 
//    Redistributions of source code must retain this copyright notice, this list of conditions and the following disclaimers. 
//    Redistributions in binary form must reproduce this copyright notice, this list of conditions and the following
//      disclaimers in the documentation and other materials provided with the distribution. 
//  Neither the names of the copyright owner nor the names of its contributors may be used to endorse or promote products derived
//  from this software without specific prior written permission. 
//  The intellectual property rights of the algorithms used reside with Andrew Aye.  You may not use this software, in whole or
//  in part, in support of any commercial product without the express written consent of the author.
//  There is no warranty or other guarantee of fitness of this software for any purpose. It is provided solely "as is".
// =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= //

// ---- IDENTITY MATRIX --------------------------------------------------------------------------------------------------------- //

TgINLINE TgVOID M(F_CLI)( M(PCU_TgMAT) ptmM0 )
{
    ptmM0->m_atvRow[0] = V(TgKV_UNIT_X);
    ptmM0->m_atvRow[1] = V(TgKV_UNIT_Y);
    ptmM0->m_atvRow[2] = V(TgKV_UNIT_Z);
}




// ---- MATRIX ARITHMETIC OPERATIONS -------------------------------------------------------------------------------------------- //

TgINLINE TgVOID M(F_CAT)( M(PCU_TgMAT) ptmRet, M(CPCU_TgMAT) ptmM0, M(CPCU_TgMAT) ptmM1 )
{
    TgUINT32                            ui0;

    for (ui0 = 0; ui0 < 3; ++ui0)
    {
        ptmRet->m_atyRowCol[ui0][0] =  ptmM0->m_atyRowCol[ui0][0] * ptmM1->m_atyRowCol[0][0]
                                    +  ptmM0->m_atyRowCol[ui0][1] * ptmM1->m_atyRowCol[1][0]
                                    +  ptmM0->m_atyRowCol[ui0][2] * ptmM1->m_atyRowCol[2][0];

        ptmRet->m_atyRowCol[ui0][1] =  ptmM0->m_atyRowCol[ui0][0] * ptmM1->m_atyRowCol[0][1]
                                    +  ptmM0->m_atyRowCol[ui0][1] * ptmM1->m_atyRowCol[1][1]
                                    +  ptmM0->m_atyRowCol[ui0][2] * ptmM1->m_atyRowCol[2][1];

        ptmRet->m_atyRowCol[ui0][2] =  ptmM0->m_atyRowCol[ui0][0] * ptmM1->m_atyRowCol[0][2]
                                    +  ptmM0->m_atyRowCol[ui0][1] * ptmM1->m_atyRowCol[1][2]
                                    +  ptmM0->m_atyRowCol[ui0][2] * ptmM1->m_atyRowCol[2][2];

        ptmRet->m_atyRowCol[ui0][3] =  ptmM0->m_atyRowCol[ui0][0] * ptmM1->m_atyRowCol[0][3]
                                    +  ptmM0->m_atyRowCol[ui0][1] * ptmM1->m_atyRowCol[1][3]
                                    +  ptmM0->m_atyRowCol[ui0][2] * ptmM1->m_atyRowCol[2][3]
                                    +  ptmM0->m_atyRowCol[ui0][3];
    };
}




// ---- INVERSE FUNCTIONS ------------------------------------------------------------------------------------------------------- //

TgINLINE TgVOID M(F_INV_DET)( M(PCU_TgMAT) ptmRet, const TYPE tyDet, M(CPCU_TgMAT) ptmM1 )
{
    if (F(tgCM_NR0)( tyDet ))
    {
        TgERROR_MSGF( 0, TgT("%-16.16s(%-32.32s): Matrix is Singular - Zero Matrix returned.\n"), TgT("Math"), TgT("F_INV") );
        M(F_CLR)( ptmRet );
    }
    else
    {
        C_TYPE                              tyInvDet = MKL(1.0) / tyDet;

        ptmRet->m.f11 =  tyInvDet*(ptmM1->m.f22 * ptmM1->m.f33 - ptmM1->m.f23 * ptmM1->m.f32);
        ptmRet->m.f12 = -tyInvDet*(ptmM1->m.f12 * ptmM1->m.f33 - ptmM1->m.f13 * ptmM1->m.f32);
        ptmRet->m.f13 =  tyInvDet*(ptmM1->m.f12 * ptmM1->m.f23 - ptmM1->m.f13 * ptmM1->m.f22);
        ptmRet->m.f14 = -(ptmRet->m.f11*ptmM1->m.f14 + ptmRet->m.f12*ptmM1->m.f24 + ptmRet->m.f13*ptmM1->m.f34);

        ptmRet->m.f21 = -tyInvDet*(ptmM1->m.f21 * ptmM1->m.f33 - ptmM1->m.f23 * ptmM1->m.f31);
        ptmRet->m.f22 =  tyInvDet*(ptmM1->m.f11 * ptmM1->m.f33 - ptmM1->m.f13 * ptmM1->m.f31);
        ptmRet->m.f23 = -tyInvDet*(ptmM1->m.f11 * ptmM1->m.f23 - ptmM1->m.f13 * ptmM1->m.f21);
        ptmRet->m.f24 = -(ptmRet->m.f21*ptmM1->m.f14 + ptmRet->m.f22*ptmM1->m.f24 + ptmRet->m.f23*ptmM1->m.f34);

        ptmRet->m.f31 =  tyInvDet*(ptmM1->m.f21 * ptmM1->m.f32 - ptmM1->m.f22 * ptmM1->m.f31);
        ptmRet->m.f32 = -tyInvDet*(ptmM1->m.f11 * ptmM1->m.f32 - ptmM1->m.f12 * ptmM1->m.f31);
        ptmRet->m.f33 =  tyInvDet*(ptmM1->m.f11 * ptmM1->m.f22 - ptmM1->m.f12 * ptmM1->m.f21);
        ptmRet->m.f34 = -(ptmRet->m.f31*ptmM1->m.f14 + ptmRet->m.f32*ptmM1->m.f24 + ptmRet->m.f33*ptmM1->m.f34);
    };
}


TgINLINE TgVOID M(F_INV)( M(PCU_TgMAT) ptmRet, M(CPCU_TgMAT) ptmM1 )
{
    M(F_INV_DET)( ptmRet, M(F_DET)( ptmM1 ), ptmM1 );
}


TgINLINE TYPE M(F_DET)( M(CPCU_TgMAT) ptmM1 )
{
    return (
        ptmM1->m.f11*(ptmM1->m.f22*ptmM1->m.f33 - ptmM1->m.f23*ptmM1->m.f32) +
        ptmM1->m.f12*(ptmM1->m.f23*ptmM1->m.f31 - ptmM1->m.f21*ptmM1->m.f33) +
        ptmM1->m.f13*(ptmM1->m.f21*ptmM1->m.f32 - ptmM1->m.f22*ptmM1->m.f31)
    );
}




// ---- TRANSFORMATION ---------------------------------------------------------------------------------------------------------- //

TgINLINE V4(TgVEC) M(F_TX_V4)( M(CPCU_TgMAT) ptxM0, V4(CPCU_TgVEC) ptvX0 )
{
    V4(TgVEC)                           tvRet;

    tvRet.m.x = V(F_DOT_VV)( ptxM0->m_atvRow + 0, ptvX0 );
    tvRet.m.y = V(F_DOT_VV)( ptxM0->m_atvRow + 1, ptvX0 );
    tvRet.m.z = V(F_DOT_VV)( ptxM0->m_atvRow + 2, ptvX0 );
    tvRet.m.w = ptvX0->m.w;

    return (tvRet);
}




// ---- GET BASIS --------------------------------------------------------------------------------------------------------------- //

TgINLINE V4(TgVEC) M(F_GET_COL_0_V4)( M(CPCU_TgMAT) ptmM0 )
{
    return (V4(F_SET_ELEM)( ptmM0->m.f11, ptmM0->m.f21, ptmM0->m.f31, MKL(0.0) ));
}


TgINLINE V4(TgVEC) M(F_GET_COL_1_V4)( M(CPCU_TgMAT) ptmM0 )
{
    return (V4(F_SET_ELEM)( ptmM0->m.f12, ptmM0->m.f22, ptmM0->m.f32, MKL(0.0) ));
}


TgINLINE V4(TgVEC) M(F_GET_COL_2_V4)( M(CPCU_TgMAT) ptmM0 )
{
    return (V4(F_SET_ELEM)( ptmM0->m.f13, ptmM0->m.f23, ptmM0->m.f33, MKL(0.0) ));
}


TgINLINE V4(TgVEC) M(F_GET_COL_3_V4)( M(CPCU_TgMAT) ptmM0 )
{
    return (V4(F_SET_ELEM)( ptmM0->m.f14, ptmM0->m.f24, ptmM0->m.f34, MKL(1.0) ));
}




// -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. //
//  Scalar Function
// -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. //

// ---- VALIDATION -------------------------------------------------------------------------------------------------------------- //

TgINLINE TgBOOL M(F_NaN)( M(CPCU_TgMAT) ptmM0 )
{
    TgUINT32                            uiIndex;

    for (uiIndex = 0; uiIndex < 12; ++uiIndex)
    {
        if (F(tgCM_NaN)( ptmM0->m_atyElement[uiIndex] ))
        {
            return (TgTRUE);
        };
    };

    return (TgFALSE);
}




// ---- INIT ROTATION [[0..2][0..2]] -------------------------------------------------------------------------------------------- //

TgINLINE TgVOID M(F_INIT_EUL_V3)( M(PCU_TgMAT) ptmRet, V3(CPCU_TgVEC) ptvEul )
{
    M(F_SET_EUL_ELEM)( ptmRet, ptvEul->m.x, ptvEul->m.y, ptvEul->m.z );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}


TgINLINE TgVOID M(F_INIT_EUL_V4)( M(PCU_TgMAT) ptmRet, V4(CPCU_TgVEC) ptvEul )
{
    M(F_SET_EUL_ELEM)( ptmRet, ptvEul->m.x, ptvEul->m.y, ptvEul->m.z );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}


TgINLINE TgVOID M(F_INIT_EUL_ELEM)( M(PCU_TgMAT) ptmRet, C_TYPE  tyX, C_TYPE  tyY, C_TYPE  tyZ )
{
    M(F_SET_EUL_ELEM)( ptmRet, tyX, tyY, tyZ );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}


TgINLINE TgVOID M(F_INIT_ELX)( M(PCU_TgMAT) ptmRet, C_TYPE  tyX )
{
    M(F_SET_ELX)( ptmRet, tyX );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}


TgINLINE TgVOID M(F_INIT_ELY)( M(PCU_TgMAT) ptmRet, C_TYPE  tyY )
{
    M(F_SET_ELY)( ptmRet, tyY );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}


TgINLINE TgVOID M(F_INIT_ELZ)( M(PCU_TgMAT) ptmRet, C_TYPE tyZ )
{
    M(F_SET_ELZ)( ptmRet, tyZ );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}


TgINLINE TgVOID M(F_INIT_ROT)( M(PCU_TgMAT) ptmRet, V4(CPCU_TgVEC) ptvEul )
{
    M(F_SET_ROT)( ptmRet, ptvEul );
    ptmRet->m.f14 = MKL(0.0);
    ptmRet->m.f24 = MKL(0.0);
    ptmRet->m.f34 = MKL(0.0);
}




// ---- GET BASIS --------------------------------------------------------------------------------------------------------------- //

TgINLINE V3(TgVEC) M(F_GET_COL_0_V3)( M(CPCU_TgMAT) ptmM0 )
{
    return (V3(F_SET_ELEM)( ptmM0->m.f11, ptmM0->m.f21, ptmM0->m.f31 ));
}


TgINLINE V3(TgVEC) M(F_GET_COL_1_V3)( M(CPCU_TgMAT) ptmM0 )
{
    return (V3(F_SET_ELEM)( ptmM0->m.f12, ptmM0->m.f22, ptmM0->m.f32 ));
}


TgINLINE V3(TgVEC) M(F_GET_COL_2_V3)( M(CPCU_TgMAT) ptmM0 )
{
    return (V3(F_SET_ELEM)( ptmM0->m.f13, ptmM0->m.f23, ptmM0->m.f33 ));
}


TgINLINE V3(TgVEC) M(F_GET_COL_3_V3)( M(CPCU_TgMAT) ptmM0 )
{
    return (V3(F_SET_ELEM)( ptmM0->m.f14, ptmM0->m.f24, ptmM0->m.f34 ));
}